fix doc for std::sync::mpmc #135876
Merged
fix doc for std::sync::mpmc #135876
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
rustbot
added
S-waiting-on-review
tgross35
reviewed
Jan 25, 2025
library/std/src/sync/mpmc/mod.rs
Outdated
Comment on lines
363
to
366
| /// hang up immediately after this function returns [`Ok`]. If the channel | ||
| /// is zero-capacity, however, the channel becomes a rendezvous channel and | ||
| /// it guarantees that the receiver has indeed received the data if this | ||
| /// function returns success. |
Contributor
There was a problem hiding this comment.
This wording is a bit tricky. Maybe something like "However, if the channel is zero-capacity, it acts as a rendezvous channel and an Ok(()) result indicates the data was successfully received" or similar.
Otherwise LGTM.
Contributor
Author
There was a problem hiding this comment.
Now changed to
However, if the channel is zero-capacity, it acts as a rendezvous channel and a
return value of [`Ok`] means that the data is successfully received.
Contributor
There was a problem hiding this comment.
Thanks, looks good with one nit: could you change "is successfully received" to "has been" or "was"?
After that please squash then r=me.
tgross35
approved these changes
Jan 27, 2025
Contributor
|
Thanks! @bors r+ rollup |
Collaborator
bors
added
S-waiting-on-bors
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix document of
std::sync::mpmc(tracked in #126840)